gridpack::parallel::GlobalVector< _data_type > Class Template Reference

#include <global_vector.hpp>

Collaboration diagram for gridpack::parallel::GlobalVector< _data_type >:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 GlobalVector (const gridpack::parallel::Communicator &comm)
 ~GlobalVector (void)
void addElements (const std::vector< int > &idx, const std::vector< _data_type > &vec)
void upload ()
void getData (const std::vector< int > &idx, std::vector< _data_type > &vec)
void getAllData (std::vector< _data_type > &vec)

template<typename _data_type>
class gridpack::parallel::GlobalVector< _data_type >


Constructor & Destructor Documentation

template<typename _data_type >
gridpack::parallel::GlobalVector< _data_type >::GlobalVector ( const gridpack::parallel::Communicator comm  ) 

Default constructor

Parameters:
comm communicator over which GlobalVector object runs. Data is accessible from any process on the communicator

References gridpack::parallel::Communicator::rank(), and gridpack::parallel::Communicator::size().

template<typename _data_type >
gridpack::parallel::GlobalVector< _data_type >::~GlobalVector ( void   ) 

Default destructor


Member Function Documentation

template<typename _data_type >
void gridpack::parallel::GlobalVector< _data_type >::addElements ( const std::vector< int > &  idx,
const std::vector< _data_type > &  vec 
)

Add elements to GlobalVector

Parameters:
vec standard vector containing data
idx vector of indices
template<typename _data_type >
void gridpack::parallel::GlobalVector< _data_type >::getAllData ( std::vector< _data_type > &  vec  ) 

Get all data from global vector

Parameters:
vec vector of returned values
template<typename _data_type >
void gridpack::parallel::GlobalVector< _data_type >::getData ( const std::vector< int > &  idx,
std::vector< _data_type > &  vec 
)

Get a vector vector of data elements corresponding to indices in idx from the GlobalVector

Parameters:
idx vector of indices for requested data
vec vector of returned values
template<typename _data_type >
void gridpack::parallel::GlobalVector< _data_type >::upload (  ) 

Upload data that is held locally into distributed array, so that it is available anywhere in the system

References gridpack::parallel::Communicator::getGroup(), and gridpack::parallel::Communicator::max().


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 3 Feb 2020 for GridPACK by  doxygen 1.6.1